Counterparties Groups Search

GET /api/v1/Counterparties/groups/search

Description

This endpoint is used to search for counterparty groups based on the search text. It returns a list of counterparty groups that match the search criteria, with the option to paginate the results.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• PageNumber: integer (int32)

• PageSize: integer (int32)

• searchText: string (nullable)

Request Body:

• None

URL:

• GET: {{baseUrl API url}}/api/v1/Counterparties/groups/search

Response:

• A CounterpartyGroupListPagedResponse object containing the list of counterparty groups that match the search criteria.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/groups/search?PageNumber=1&PageSize=10&searchText=Business

Response:

HTTP/1.1 200 OK
{
  "totalCount": 2,
  "pageNumber": 1,
  "pageSize": 10,
  "totalPages": 1,
  "results": [
    {
      "id": "1234567890",
      "name": "Business Partners",
      "description": "Group for business partners",
      "count": 50,
      "counterparties": [
        {
          "id": "abc123",
          "name": "Business Partner 1",
          "type": "Vendor"
        },
        {
          "id": "def456",
          "name": "Business Partner 2",
          "type": "Customer"
        },
        ...
      ]
    },
    ...
  ]
}

Method: GET

/api/v1/Counterparties/groups/search?PageNumber=<integer>&PageSize=<integer>&searchText=<string>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
PageNumber	<integer>
PageSize	<integer>
searchText	<string>

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "name": "<string>",
      "merchantId": "<uuid>",
      "id": "<uuid>"
    },
    {
      "name": "<string>",
      "merchantId": "<uuid>",
      "id": "<uuid>"
    }
  ]
}